<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.7"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>netLink C++ 11: include/Header.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">netLink C++ 11
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.7 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">Header.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/*</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment">    netLink: c++ 11 networking library</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment">    Copyright (C) 2013-2023 Alexander Meißner</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"></span> </div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment">    This program is free software: you can redistribute it and/or modify</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment">    it under the terms of the GNU General Public License as published by</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment">    the Free Software Foundation, either version 3 of the License, or</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment">    (at your option) any later version.</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"></span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment">    This program is distributed in the hope that it will be useful,</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment">    but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment">    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment">    GNU General Public License for more details.</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment"></span> </div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment">    You should have received a copy of the GNU General Public License</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment">    along with this program.  If not, see &lt;http://www.gnu.org/licenses/&gt;.</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment">*/</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span> </div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="preprocessor">#include &quot;Element.h&quot;</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span> </div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span><span class="keyword">namespace </span>MsgPack {</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span> </div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"><a class="line" href="class_msg_pack_1_1_header.html">   26</a></span>    <span class="keyword">class </span><a class="code hl_class" href="class_msg_pack_1_1_header.html">Header</a> : <span class="keyword">public</span> <a class="code hl_class" href="class_msg_pack_1_1_element.html">Element</a> {</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span>        <span class="keyword">friend</span> <span class="keyword">class </span><a class="code hl_class" href="class_msg_pack_1_1_serializer.html">Serializer</a>;</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span>        <span class="keyword">friend</span> <span class="keyword">class </span><a class="code hl_class" href="class_msg_pack_1_1_deserializer.html">Deserializer</a>;</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span>        <span class="keyword">protected</span>:</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"><a class="line" href="class_msg_pack_1_1_header.html#aad66a58f9f1c736cd57a1889049d0a8b">   30</a></span>        <span class="keywordtype">char</span> <a class="code hl_variable" href="class_msg_pack_1_1_header.html#aad66a58f9f1c736cd57a1889049d0a8b">header</a>[5]; </div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span>        int64_t <a class="code hl_function" href="class_msg_pack_1_1_header.html#a61a541b11c0c76e2953e1e8a49c33fe5">startSerialize</a>();</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span>        int64_t <a class="code hl_function" href="class_msg_pack_1_1_header.html#a09ece23cec4435cc501889997160b672">startDeserialize</a>(uint8_t firstByte);</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span>        std::streamsize <a class="code hl_function" href="class_msg_pack_1_1_header.html#a83ad27bdd37805f1a8e3df0fa477d542">serialize</a>(int64_t&amp; pos, std::basic_streambuf&lt;char&gt;* streamBuffer, std::streamsize bytes);</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span>        std::streamsize <a class="code hl_function" href="class_msg_pack_1_1_header.html#a2be15a3892d70af569c7339b2c69d485">deserialize</a>(int64_t&amp; pos, std::basic_streambuf&lt;char&gt;* streamBuffer, std::streamsize bytes);</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span>        int64_t <a class="code hl_function" href="class_msg_pack_1_1_header.html#a51fa94540ec8c1634f148308ffc0b872">getEndPos</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"><a class="line" href="class_msg_pack_1_1_header.html#a6a976df4c8619f08fdac6e67c7c6ab7e">   37</a></span>        <span class="keyword">virtual</span> int64_t <a class="code hl_function" href="class_msg_pack_1_1_header.html#a6a976df4c8619f08fdac6e67c7c6ab7e">getHeaderLength</a>() <span class="keyword">const</span> = 0;</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span>        <span class="keyword">public</span>:</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span>        Type <a class="code hl_function" href="class_msg_pack_1_1_header.html#a6b027375f99031ac2458cc40e3128411">getType</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span>        uint32_t <a class="code hl_function" href="class_msg_pack_1_1_header.html#ae54f5090f9929e9369b77ad79d2e8a34">getSizeInBytes</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span>        <span class="keyword">virtual</span> uint32_t <a class="code hl_function" href="class_msg_pack_1_1_header.html#a62d4ab7d5c583312647f33845e52cd13">getLength</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span>    };</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span> </div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span>};</div>
<div class="ttc" id="aclass_msg_pack_1_1_deserializer_html"><div class="ttname"><a href="class_msg_pack_1_1_deserializer.html">MsgPack::Deserializer</a></div><div class="ttdoc">Used to deserialize elements from a std::streambuf.</div><div class="ttdef"><b>Definition</b> StreamManager.h:71</div></div>
<div class="ttc" id="aclass_msg_pack_1_1_element_html"><div class="ttname"><a href="class_msg_pack_1_1_element.html">MsgPack::Element</a></div><div class="ttdoc">Abstract class to represent one element in a MsgPack stream.</div><div class="ttdef"><b>Definition</b> Element.h:100</div></div>
<div class="ttc" id="aclass_msg_pack_1_1_header_html"><div class="ttname"><a href="class_msg_pack_1_1_header.html">MsgPack::Header</a></div><div class="ttdoc">MsgPack::Element to represent the header of a dynamical length element.</div><div class="ttdef"><b>Definition</b> Header.h:26</div></div>
<div class="ttc" id="aclass_msg_pack_1_1_header_html_a09ece23cec4435cc501889997160b672"><div class="ttname"><a href="class_msg_pack_1_1_header.html#a09ece23cec4435cc501889997160b672">MsgPack::Header::startDeserialize</a></div><div class="ttdeci">int64_t startDeserialize(uint8_t firstByte)</div><div class="ttdoc">Reads in one byte and returns the initial deserializer position in bytes (negative value if there is ...</div><div class="ttdef"><b>Definition</b> MsgPack.cpp:199</div></div>
<div class="ttc" id="aclass_msg_pack_1_1_header_html_a2be15a3892d70af569c7339b2c69d485"><div class="ttname"><a href="class_msg_pack_1_1_header.html#a2be15a3892d70af569c7339b2c69d485">MsgPack::Header::deserialize</a></div><div class="ttdeci">std::streamsize deserialize(int64_t &amp;pos, std::basic_streambuf&lt; char &gt; *streamBuffer, std::streamsize bytes)</div><div class="ttdoc">Deserializes bytes at the given deserializer position pos from streamBuffer.</div><div class="ttdef"><b>Definition</b> MsgPack.cpp:214</div></div>
<div class="ttc" id="aclass_msg_pack_1_1_header_html_a51fa94540ec8c1634f148308ffc0b872"><div class="ttname"><a href="class_msg_pack_1_1_header.html#a51fa94540ec8c1634f148308ffc0b872">MsgPack::Header::getEndPos</a></div><div class="ttdeci">int64_t getEndPos() const</div><div class="ttdoc">Returns the first invalid (de)serializer position.</div><div class="ttdef"><b>Definition</b> MsgPack.cpp:224</div></div>
<div class="ttc" id="aclass_msg_pack_1_1_header_html_a61a541b11c0c76e2953e1e8a49c33fe5"><div class="ttname"><a href="class_msg_pack_1_1_header.html#a61a541b11c0c76e2953e1e8a49c33fe5">MsgPack::Header::startSerialize</a></div><div class="ttdeci">int64_t startSerialize()</div><div class="ttdoc">Returns the initial serializer position in bytes (negative value if there is a header)</div><div class="ttdef"><b>Definition</b> MsgPack.cpp:195</div></div>
<div class="ttc" id="aclass_msg_pack_1_1_header_html_a62d4ab7d5c583312647f33845e52cd13"><div class="ttname"><a href="class_msg_pack_1_1_header.html#a62d4ab7d5c583312647f33845e52cd13">MsgPack::Header::getLength</a></div><div class="ttdeci">virtual uint32_t getLength() const</div><div class="ttdoc">Returns the content length in bytes.</div><div class="ttdef"><b>Definition</b> MsgPack.cpp:240</div></div>
<div class="ttc" id="aclass_msg_pack_1_1_header_html_a6a976df4c8619f08fdac6e67c7c6ab7e"><div class="ttname"><a href="class_msg_pack_1_1_header.html#a6a976df4c8619f08fdac6e67c7c6ab7e">MsgPack::Header::getHeaderLength</a></div><div class="ttdeci">virtual int64_t getHeaderLength() const =0</div><div class="ttdoc">Returns the size of the header in bytes.</div></div>
<div class="ttc" id="aclass_msg_pack_1_1_header_html_a6b027375f99031ac2458cc40e3128411"><div class="ttname"><a href="class_msg_pack_1_1_header.html#a6b027375f99031ac2458cc40e3128411">MsgPack::Header::getType</a></div><div class="ttdeci">Type getType() const</div><div class="ttdoc">Returns the MsgPack::Type.</div><div class="ttdef"><b>Definition</b> MsgPack.cpp:228</div></div>
<div class="ttc" id="aclass_msg_pack_1_1_header_html_a83ad27bdd37805f1a8e3df0fa477d542"><div class="ttname"><a href="class_msg_pack_1_1_header.html#a83ad27bdd37805f1a8e3df0fa477d542">MsgPack::Header::serialize</a></div><div class="ttdeci">std::streamsize serialize(int64_t &amp;pos, std::basic_streambuf&lt; char &gt; *streamBuffer, std::streamsize bytes)</div><div class="ttdoc">Serializes bytes at the given serializer position pos into streamBuffer.</div><div class="ttdef"><b>Definition</b> MsgPack.cpp:204</div></div>
<div class="ttc" id="aclass_msg_pack_1_1_header_html_aad66a58f9f1c736cd57a1889049d0a8b"><div class="ttname"><a href="class_msg_pack_1_1_header.html#aad66a58f9f1c736cd57a1889049d0a8b">MsgPack::Header::header</a></div><div class="ttdeci">char header[5]</div><div class="ttdoc">Internal buffer of the header.</div><div class="ttdef"><b>Definition</b> Header.h:30</div></div>
<div class="ttc" id="aclass_msg_pack_1_1_header_html_ae54f5090f9929e9369b77ad79d2e8a34"><div class="ttname"><a href="class_msg_pack_1_1_header.html#ae54f5090f9929e9369b77ad79d2e8a34">MsgPack::Header::getSizeInBytes</a></div><div class="ttdeci">uint32_t getSizeInBytes() const</div><div class="ttdoc">Returns the size in bytes this MsgPack::Element takes if completely serialized.</div><div class="ttdef"><b>Definition</b> MsgPack.cpp:236</div></div>
<div class="ttc" id="aclass_msg_pack_1_1_serializer_html"><div class="ttname"><a href="class_msg_pack_1_1_serializer.html">MsgPack::Serializer</a></div><div class="ttdoc">Used to serialize elements into a std::streambuf.</div><div class="ttdef"><b>Definition</b> StreamManager.h:37</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.7
</small></address>
</body>
</html>
